5.5 查询外部用户详情(支持根据name查询)

基本信息

Path: /api/v2/externalUser/queryUser

Method: GET

接口描述:

请求参数

Query

注意: 1. 各个样例之间为并列关系, 实际发送请求时只需参照其中某一个即可

根据id查询

参数名称 类型 是否必须 示例 备注
id string 必须 外部用户ID

根据name查询

参数名称 类型 是否必须 示例 备注 其他信息
name string 必须 外部用户名
userDirectoryId string 与userDirectoryName二选一 所属用户目录ID userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
userDirectoryName string 与userDirectoryId二选一 所属用户目录名称 userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
  1. 如果响应状态码为401且控制台【审计中心/设备安全日志】中存在接口攻击行为日志,处置原因为[SNORT]SNORT ACTION: BLOCK。说明是设备检测到了请求中存在攻击特征,触发了自动拦截。请检查name或者userDirectoryName参数中是否存在SQL或命令注入特征,如select、delete等关键字,如果存在请修改用户名或者用户目录名后重试。如需协助,可联系深信服客户服务热线:400-630-6430。

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 返回码,0 返回成功
data object 必须 报文数据主体
├─ data object[] 必须 数据
├─├─ id string 必须 用户ID
├─├─ displayName string 必须 显示名
├─├─ externalId string 必须 外部ID
├─├─ name string 必须 名称
├─├─ path string 必须 所属组织架构
├─├─ status number 必须 启用状态:0禁用,1启用
├─├─ phone string 必须 手机号码
├─├─ email string 必须 电子邮件
├─├─ expiredTime string 必须 过期时间,时间戳,13位长度,单位毫秒,'0'表示永不过期
├─├─ description string 必须 描述
├─├─ resourceList object[] 非必须 直接关联的应用和应用分类
├─├─├─ dataType string 必须 resource为应用,group为应用分类
├─├─├─ id string 非必须 应用/应用分类ID
├─├─├─ name string 非必须 应用/应用分类名
├─├─├─ accessModel string 非必须 应用接入类型,WEB,L3VPN(应该分类无此字段)
├─├─├─ description string 非必须 应用/应用分类描述
├─├─├─ status string 非必须 启用状态,0禁用,1启用
├─├─ roleList object[] 非必须 角色列表
├─├─├─ id string 非必须 角色ID
├─├─├─ name string 非必须 角色名
├─├─├─ description string 非必须 角色描述
├─├─ ext object 必须 扩展字段
├─├─├─fieldDataSource object 必须 认证时用户数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─displayName string 必须 显示名数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─description string 必须 描述数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─email string 必须 电子邮件数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─expiredTime string 必须 过期时间数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─path string 必须 所属组织架构数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─phone string 必须 手机号码数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─status string 必须 启用状态数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─ authComposeId string 必须 认证策略ID
├─├─ authComposeName string 必须 认证策略名称
├─├─ authCompose string 必须 认证策略
├─├─├─ id string 必须 策略id
├─├─├─ name string 必须 策略名称
├─├─ inheritGroup string 必须 继承组织架构 1为继承,0为不继承
├─├─ inheritRole string 必须 继承角色 1为继承,0为不继承
├─├─ userPolicy object 必须 用户策略
├─├─├─ id string 必须 策略id
├─├─├─ name string 必须 策略名称
├─├─ isDeleted number 必须 外部已删除:0未删除,1已删除  

返回示例

{
    "code": 0,
    "data": {
        "data": [
            {
                "id": "238eb5e0-4f08-11eb-a22f-4f6c72112dad",
                "authComposeId": "a84ebf70-0ed8-11eb-abd5-850e8cafdb99",
                "name": "EXUSER",
                "path": "/",
                "status": 1,
                "phone": "",
                "email": "",
                "expiredTime": "1609862399000",
                "description": "",
                "ext": {
                    "fieldDataSource": {
                        "status": "local",
                        "path": "local",
                        "phone": "local",
                        "email": "local",
                        "expiredTime": "local",
                        "description": "local",
                        "label": "local"
                    }
                },
                "authComposeName": "默认策略",
                "authCompose": {
                    "id": "a84ebf70-0ed8-11eb-abd5-850e8cafdb99",
                    "name": "默认策略"
                },
                "roleList": [
                {
                    "id": "54f643f0-5717-11eb-b6e0-f7651d8dccc0",
                    "name": "band1",
                    "description": ""
                },
                {
                    "id": "64f643f0-5717-11eb-b6e0-f7651d8dccc0",
                    "name": "band2",
                    "description": ""
                }
            ],
                "inheritGroup": 1,
                "inheritRole": 1,
                "userPolicy": {
                    "id": "default",
                    "name": "默认策略"
                },
                "isDeleted": 0
            }
        ]
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
参数检查出错 10000001
用户目录不存在 77200001
外部用户不存在 77200001
用户不存在 77200004
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-09-05 14:20

results matching ""

    No results matching ""